πŸ’» REST

@Seongukbaek Posted February 19, 2022 Β· Updated February 19, 2022 Β· 7 min read

REST의 κ°œλ…μ— λŒ€ν•΄μ„œ μ •λ¦¬ν•˜λŠ” POSTμž…λ‹ˆλ‹€.

πŸ”§ REST

βš™οΈ REST의 μ •μ˜

: "Representational State Transfer"의 μ•½μžλ‘œ, μžμ›μ„ μ΄λ¦„μœΌλ‘œ κ΅¬λΆ„ν•˜μ—¬ μžμ›μ˜ μƒνƒœμ •λ³΄λ₯Ό μ£Όκ³  λ°›λŠ” λͺ¨λ“  것을 μ˜λ―Έν•œλ‹€.

  • HTTP URIλ₯Ό 톡해 μžμ›μ„ λͺ…μ‹œν•˜κ³ ,
  • HTTP Method(POST, GET, PUT, DELETE)λ₯Ό 톡해 ν•΄λ‹Ή μžμ›(URI)에 λŒ€ν•œ CRUDλ₯Ό μ μš©ν•˜λŠ” 것이닀.

πŸ”© ꡬ성 μš”μ†Œ

  • μžμ› : HTTP URI의 ν˜•νƒœ
  • μžμ›μ— λŒ€ν•œ ν–‰μœ„ : HTTP Method
  • μžμ›μ— λŒ€ν•œ ν–‰μœ„μ˜ λ‚΄μš© : HTTP Message payload

πŸ”‘ νŠΉμ§•

  1. Server-Client(μ„œλ²„-ν΄λΌμ΄μ–ΈνŠΈ ꡬ쑰) : REST μ„œλ²„λŠ” API 제곡, ν΄λΌμ΄μ–ΈνŠΈλŠ” μ‚¬μš©μž μΈμ¦μ΄λ‚˜ Context(session, 둜그인 정보) 등을 직접 κ΄€λ¦¬ν•˜λŠ” ꡬ쑰둜, 각각의 역할이 ν™•μ‹€νžˆ κ΅¬λΆ„λ˜κΈ° λ•Œλ¬Έμ— ν΄λΌμ΄μ–ΈνŠΈμ™€ μ„œλ²„μ—μ„œ κ°œλ°œν•΄μ•Ό ν•  λ‚΄μš©μ΄ λͺ…ν™•ν•΄μ§€κ³  μ„œλ‘œ κ°„ μ˜μ‘΄μ„±μ΄ μ€„μ–΄λ“€κ²Œ λœλ‹€.
  2. Stateless(λ¬΄μƒνƒœ) : RESTλŠ” μƒνƒœλ₯Ό κ°€μ§€μ§€ μ•ŠλŠ”λ‹€. 즉 μž‘μ—…μ„ μœ„ν•œ μƒνƒœμ •λ³΄λ₯Ό μ €μž₯ν•˜κ±°λ‚˜ κ΄€λ¦¬ν•˜μ§€ μ•ŠλŠ”λ‹€. μœ„μ—μ„œ μ„€λͺ…ν–ˆλ“―, μ„œλ²„λŠ” session μ •λ³΄λ‚˜ μΏ ν‚€ 정보λ₯Ό λ³„λ„λ‘œ μ €μž₯ν•˜κ³  κ΄€λ¦¬ν•˜μ§€ μ•ŠκΈ°μ— λ‹¨μˆœνžˆ λ“€μ–΄μ˜€λŠ” μš”μ²­λ§Œμ„ μ²˜λ¦¬ν•˜λŠ” ꡬ쑰이닀. λ”°λΌμ„œ μ„œλΉ„μŠ€μ˜ μžμœ λ„κ°€ λ†’μ•„μ§€κ³  μ„œλ²„μ—μ„œμ˜ κ΅¬ν˜„μ΄ λ‹¨μˆœν•΄μ§„λ‹€.
  3. Cacheable(μΊμ‹œ 처리 κ°€λŠ₯) : HTTPλΌλŠ” κΈ°μ‘΄ μ›Ή ν‘œμ€€μ„ κ·ΈλŒ€λ‘œ μ‚¬μš©ν•˜κΈ°μ—, μ›Ήμ—μ„œ μ‚¬μš©ν•˜λŠ” κΈ°μ‘΄ 인프라λ₯Ό κ·ΈλŒ€λ‘œ ν™œμš©ν•  수 μžˆλ‹€. 즉, HTTPκ°€ κ°€μ§„ 캐싱 κΈ°λŠ₯을 μ μš©ν•  수 μžˆλ‹€. (Last-Modified or E-Tag μ‚¬μš©)
  4. Layered System(계측화) : REST μ„œλ²„λŠ” 닀쀑 κ³„μΈ΅μœΌλ‘œ ꡬ성될 수 있으며, λ³΄μ•ˆ, load balancing, μ•”ν˜Έν™” 계측을 μΆ”κ°€ν•΄ μœ μ—°μ„±μ„ λ‘˜ 수 μžˆλ‹€. λ˜ν•œ PROXY, Gateway 같은 λ„€νŠΈμ›Œν¬ 기반의 쀑간 맀체λ₯Ό μ‚¬μš©ν•  수 있게 ν•œλ‹€.
  5. Uniform Interface(μΈν„°νŽ˜μ΄μŠ€ 일관성) : μœ„μ—μ„œ μ–ΈκΈ‰ν–ˆλ“―, HTTP ν‘œμ€€μ„ λ”°λ₯΄κΈ°μ— νŠΉμ • μ–Έμ–΄λ‚˜ κΈ°μˆ μ— μ’…μ†λ˜μ§€ μ•Šκ³  λͺ¨λ“  ν”Œλž«νΌμ— μ‚¬μš©ν•  수 있으며, URI둜 μ§€μ •ν•œ μžμ›μ— λŒ€ν•œ μ‘°μž‘μ΄ κ°€λŠ₯ν•˜λ‹€.

πŸ”’ μž₯단점

μž₯점
  • HTTP 인프라λ₯Ό κ·ΈλŒ€λ‘œ μ‚¬μš©ν•˜λ―€λ‘œ REST API μ‚¬μš©μ„ μœ„ν•œ 별도 인프라 ꡬ좕이 ν•„μš”ν•˜μ§€ μ•Šλ‹€.

    • λ˜ν•œ, HTTP ν‘œμ€€μ„ μ΅œλŒ€ν•œ ν™œμš©ν•˜μ—¬ μ—¬λŸ¬ μΆ”κ°€ μž₯점을 κ°€μ§„λ‹€.
  • HTTP ν‘œμ€€μ„ λ”°λ₯΄λŠ” λͺ¨λ“  ν”Œλž«νΌμ—μ„œ μ‚¬μš© κ°€λŠ₯ν•˜λ‹€. (Uniform Interface)
  • Hypermedia API λ‚΄μ—μ„œ, λ²”μš©μ„±μ„ 보μž₯ν•œλ‹€.

    • Hypermedia API : λ‹€λ₯Έ 말둜 HATEOAS(Hypermedia As The Engine Of Application State)둜, hypermediaλ₯Ό application의 μƒνƒœλ₯Ό κ΄€λ¦¬ν•˜κΈ° μœ„ν•œ λ§€μ»€λ‹ˆμ¦˜μœΌλ‘œ μ‚¬μš©ν•œλ‹€λŠ” κ°œλ…μ΄λ‹€. REST API κ΅¬ν˜„μ˜ λ§ˆμ§€λ§‰ λ‹¨κ³„λ‘œ, API 관리에 어렀움이 μžˆλ‹€λ©΄ λ„μž…μ„ κ³ λ €ν•΄λ³Όλ§Œν•˜λ‹€.

  • REST API λ©”μ„Έμ§€κ°€ μ˜λ„ν•˜λŠ” λ°”λ₯Ό λͺ…ν™•ν•˜κ²Œ λ‚˜νƒ€λ‚΄κΈ°μ— μ˜λ„λ₯Ό νŒŒμ•…ν•˜κΈ° 쉽닀.
  • μ„œλ²„μ™€ ν΄λΌμ΄μ–ΈνŠΈμ˜ 역할을 λͺ…ν™•ν•˜κ²Œ λΆ„λ¦¬ν•œλ‹€.
단점
  • ν‘œμ€€μ΄ μ‘΄μž¬ν•˜μ§€ μ•Šμ•„ μ •μ˜κ°€ ν•„μš”ν•˜κ³  관리가 쉽지 μ•Šλ‹€.
  • μ‚¬μš©ν•  수 μžˆλŠ” λ©”μ†Œλ“œκ°€ 4가지뿐이닀. (HTTP λ©”μ†Œλ“œκ°€ μ œν•œμ )
  • μ•ˆν‹°νŒ¨ν„΄μœΌλ‘œ 섀계될 κ°€λŠ₯성이 μžˆλ‹€.

    • μ•ˆν‹°νŒ¨ν„΄ : ν‘œμ€€μ΄ 없기에 REST API이 νŠΉμ§•μ„ μ΄ν•΄ν•˜μ§€ λͺ»ν•˜κ³  μ–΄κΈ‹λ‚˜λŠ” νŒ¨ν„΄ HTTP λ©”μ†Œλ“œμ˜ 잘λͺ»λœ μ‚¬μš©, HTTP Response code의 μ œν•œμ  ν™œμš©μ΄ 원인이 될 수 μžˆλ‹€.


πŸ”¨ REST API

🧭 REST API의 μ •μ˜

: RESTλ₯Ό 기반으둜 λ§Œλ“€μ–΄μ§„ API

πŸ”¦ νŠΉμ§•

  • REST 기반으둜 μ‹œμŠ€ν…œμ„ λΆ„μ‚°ν•΄ ν™•μž₯μ„±κ³Ό μž¬μ‚¬μš©μ„±μ„ λ†’μ—¬ μœ μ§€λ³΄μˆ˜ 및 운용이 νŽΈλ¦¬ν•΄μ§„λ‹€.
  • HTTP ν‘œμ€€μ„ 기반으둜 κ΅¬ν˜„ν•΄, HTTPλ₯Ό μ§€μ›ν•˜λŠ” ν”„λ‘œκ·Έλž¨ μ–Έμ–΄λ‘œ ν΄λΌμ΄μ–ΈνŠΈμ™€ μ„œλ²„λ₯Ό κ΅¬ν˜„ν•  수 μžˆλ‹€.

πŸ•― 섀계

κΈ°λ³Έ κ·œμΉ™
  1. URIλŠ” μ •λ³΄μ˜ μžμ›μ„ ν‘œν˜„ν•œλ‹€.
  2. μžμ›μ— λŒ€ν•œ ν–‰μœ„λŠ” HTTP λ©”μ†Œλ“œλ‘œ ν‘œν˜„ν•œλ‹€.
μ˜ˆμ‹œ
CRUD HTTP λ©”μ†Œλ“œ Route
μžμ›λ“€μ˜ λͺ©λ‘μ„ ν‘œμ‹œ GET /resource
μžμ› ν•˜λ‚˜μ˜ λ‚΄μš©μ„ ν‘œμ‹œ GET /resource/:id
μžμ› 생성 POST /resource
μžμ› μˆ˜μ • PUT /resource/:id
μžμ› μ‚­μ œ DELETE /resource/:id

⛏ RESTful

πŸ’³ RESTful의 μ •μ˜

: 일반적으둜 RESTλΌλŠ” μ•„ν‚€ν…μ²˜λ₯Ό κ΅¬ν˜„ν•˜λŠ” μ›Ή μ„œλΉ„μŠ€ (REST APIλ₯Ό μ œκ³΅ν•˜λŠ” μ›Ή μ„œλΉ„μŠ€)

  • RESTfulν•œ APIλ₯Ό κ΅¬ν˜„ν•˜λŠ” 근본적인 λͺ©μ μ€ μ„±λŠ₯ ν–₯상이 μ•„λ‹Œ 일관적인 μ»¨λ²€μ…˜μ„ ν†΅ν•œ API의 이해도 및 ν˜Έν™˜μ„±μ„ λ†’μ΄λŠ” 것이닀. λ”°λΌμ„œ μ„±λŠ₯이 μ€‘μš”ν•œ 경우 ꡳ이 이λ₯Ό κ΅¬ν˜„ν•  ν•„μš”λŠ” μ—†λ‹€.

πŸ’£ RESTfulν•˜μ§€ λͺ»ν•œ 경우

  • CRUD κΈ°λŠ₯을 λͺ¨λ‘ POST둜만 μ²˜λ¦¬ν•˜λŠ” 경우, 즉 HTTP λ©”μ†Œλ“œλ₯Ό λͺ¨λ‘ ν™œμš©ν•˜μ§€ μ•ŠλŠ” 경우
  • Route에 resource, id μ™Έμ˜ 정보가 λ“€μ–΄κ°€λŠ” 경우(ex. /students/updateName)

πŸ“• μ°Έκ³ 

@Seongukbaek
배우고 μ •λ¦¬ν•˜κ³  κ³΅μœ ν•˜λŠ” λŒ€ν•™μƒ λ°±μ„±μš±μž…λ‹ˆλ‹€ πŸ˜€